<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: ipc::transport::sync_io::Blob_sender Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Public API.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceipc.html">ipc</a></li><li class="navelem"><a class="el" href="namespaceipc_1_1transport.html">transport</a></li><li class="navelem"><a class="el" href="namespaceipc_1_1transport_1_1sync__io.html">sync_io</a></li><li class="navelem"><a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__sender.html">Blob_sender</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="classipc_1_1transport_1_1sync__io_1_1Blob__sender-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">ipc::transport::sync_io::Blob_sender Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>A documentation-only <em>concept</em>: what <a class="el" href="classipc_1_1transport_1_1Blob__sender.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order sending ...">transport::Blob_sender</a> is to <a class="el" href="classipc_1_1transport_1_1Native__handle__sender.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order sending ...">transport::Native_handle_sender</a> (namely a degenerate version thereof), this is to <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html" title="A documentation-only concept defining the behavior of an object that is the sync_io-pattern counterpa...">sync_io::Native_handle_sender</a>.  
 <a href="classipc_1_1transport_1_1sync__io_1_1Blob__sender.html#details">More...</a></p>

<p><code>#include &lt;blob_transport.hpp&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ipc::transport::sync_io::Blob_sender:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classipc_1_1transport_1_1sync__io_1_1Blob__sender__coll__graph.svg" width="284" height="203"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ab096af43b37c0fc0169762f59e1a74dd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__sender.html#ab096af43b37c0fc0169762f59e1a74dd">Blob_sender</a> ()</td></tr>
<tr class="memdesc:ab096af43b37c0fc0169762f59e1a74dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default ctor: Creates a peer object in NULL (neither connected nor connecting) state.  <a href="classipc_1_1transport_1_1sync__io_1_1Blob__sender.html#ab096af43b37c0fc0169762f59e1a74dd">More...</a><br /></td></tr>
<tr class="separator:ab096af43b37c0fc0169762f59e1a74dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a73dc49c48192a958ece03e3823b9927a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__sender.html#a73dc49c48192a958ece03e3823b9927a">Blob_sender</a> (<a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__sender.html">Blob_sender</a> &amp;&amp;src)</td></tr>
<tr class="memdesc:a73dc49c48192a958ece03e3823b9927a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move-constructs from <code>src</code>; <code>src</code> becomes as-if default-cted (therefore in NULL state).  <a href="classipc_1_1transport_1_1sync__io_1_1Blob__sender.html#a73dc49c48192a958ece03e3823b9927a">More...</a><br /></td></tr>
<tr class="separator:a73dc49c48192a958ece03e3823b9927a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aefec7dd235173e0c28bb3e3ae6d19075"><td class="memItemLeft" align="right" valign="top"><a id="aefec7dd235173e0c28bb3e3ae6d19075" name="aefec7dd235173e0c28bb3e3ae6d19075"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Blob_sender</b> (const <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__sender.html">Blob_sender</a> &amp;)=delete</td></tr>
<tr class="memdesc:aefec7dd235173e0c28bb3e3ae6d19075"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disallow copying. <br /></td></tr>
<tr class="separator:aefec7dd235173e0c28bb3e3ae6d19075"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5b6fd92f1c435e13dcf6df40c76b3ce2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__sender.html#a5b6fd92f1c435e13dcf6df40c76b3ce2">~Blob_sender</a> ()</td></tr>
<tr class="memdesc:a5b6fd92f1c435e13dcf6df40c76b3ce2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys this peer endpoint which will end the conceptual outgoing-direction pipe (in PEER state, and if it's still active) and return resources to OS as applicable.  <a href="classipc_1_1transport_1_1sync__io_1_1Blob__sender.html#a5b6fd92f1c435e13dcf6df40c76b3ce2">More...</a><br /></td></tr>
<tr class="separator:a5b6fd92f1c435e13dcf6df40c76b3ce2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a8be6c513d5ba45ef3396c4b5dd65d0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__sender.html">Blob_sender</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__sender.html#a2a8be6c513d5ba45ef3396c4b5dd65d0">operator=</a> (<a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__sender.html">Blob_sender</a> &amp;&amp;src)</td></tr>
<tr class="memdesc:a2a8be6c513d5ba45ef3396c4b5dd65d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move-assigns from <code>src</code>; <code>*this</code> acts as if destructed; <code>src</code> becomes as-if default-cted (therefore in NULL state).  <a href="classipc_1_1transport_1_1sync__io_1_1Blob__sender.html#a2a8be6c513d5ba45ef3396c4b5dd65d0">More...</a><br /></td></tr>
<tr class="separator:a2a8be6c513d5ba45ef3396c4b5dd65d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abaf91d3ddf61b8ad87145a443272e72e"><td class="memItemLeft" align="right" valign="top"><a id="abaf91d3ddf61b8ad87145a443272e72e" name="abaf91d3ddf61b8ad87145a443272e72e"></a>
<a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__sender.html">Blob_sender</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__sender.html">Blob_sender</a> &amp;)=delete</td></tr>
<tr class="memdesc:abaf91d3ddf61b8ad87145a443272e72e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disallow copying. <br /></td></tr>
<tr class="separator:abaf91d3ddf61b8ad87145a443272e72e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a15da7ad5bcf7147e6308d532f1432352"><td class="memTemplParams" colspan="2">template&lt;typename Create_ev_wait_hndl_func &gt; </td></tr>
<tr class="memitem:a15da7ad5bcf7147e6308d532f1432352"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__sender.html#a15da7ad5bcf7147e6308d532f1432352">replace_event_wait_handles</a> (const Create_ev_wait_hndl_func &amp;create_ev_wait_hndl_func)</td></tr>
<tr class="memdesc:a15da7ad5bcf7147e6308d532f1432352"><td class="mdescLeft">&#160;</td><td class="mdescRight">Coincides with <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html" title="A documentation-only concept defining the behavior of an object that is the sync_io-pattern counterpa...">sync_io::Native_handle_sender</a> concept counterpart.  <a href="classipc_1_1transport_1_1sync__io_1_1Blob__sender.html#a15da7ad5bcf7147e6308d532f1432352">More...</a><br /></td></tr>
<tr class="separator:a15da7ad5bcf7147e6308d532f1432352"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7676391885035faa7195c0840ae2009"><td class="memTemplParams" colspan="2">template&lt;typename Event_wait_func_t &gt; </td></tr>
<tr class="memitem:aa7676391885035faa7195c0840ae2009"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__sender.html#aa7676391885035faa7195c0840ae2009">start_send_blob_ops</a> (Event_wait_func_t &amp;&amp;ev_wait_func)</td></tr>
<tr class="memdesc:aa7676391885035faa7195c0840ae2009"><td class="mdescLeft">&#160;</td><td class="mdescRight">All notes from <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#a8c34b110850c736c45d88689ab06c27c" title="Sets up the sync_io-pattern interaction between *this and the user&#39;s event loop; required before send...">sync_io::Native_handle_sender::start_send_native_handle_ops()</a> apply.  <a href="classipc_1_1transport_1_1sync__io_1_1Blob__sender.html#aa7676391885035faa7195c0840ae2009">More...</a><br /></td></tr>
<tr class="separator:aa7676391885035faa7195c0840ae2009"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a57611f88b625f095d4a6a0f0e5d9e665"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__sender.html#a57611f88b625f095d4a6a0f0e5d9e665">send_blob_max_size</a> () const</td></tr>
<tr class="memdesc:a57611f88b625f095d4a6a0f0e5d9e665"><td class="mdescLeft">&#160;</td><td class="mdescRight">All notes from <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html" title="A documentation-only concept defining the behavior of an object that is the sync_io-pattern counterpa...">sync_io::Native_handle_sender</a> apply.  <a href="classipc_1_1transport_1_1sync__io_1_1Blob__sender.html#a57611f88b625f095d4a6a0f0e5d9e665">More...</a><br /></td></tr>
<tr class="separator:a57611f88b625f095d4a6a0f0e5d9e665"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:add3aa0b782c02b3e1222b4ee25598ecc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__sender.html#add3aa0b782c02b3e1222b4ee25598ecc">send_blob</a> (const <a class="el" href="namespaceipc_1_1util.html#ae0be7edba7e30ffa3f8b742af621f2ab">util::Blob_const</a> &amp;blob, <a class="el" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a> *err_code=0)</td></tr>
<tr class="memdesc:add3aa0b782c02b3e1222b4ee25598ecc"><td class="mdescLeft">&#160;</td><td class="mdescRight">In PEER state: Synchronously, non-blockingly sends one discrete message, reliably and in-order, to the opposing peer; the message consists of the provided binary blob (of length at least 1 byte).  <a href="classipc_1_1transport_1_1sync__io_1_1Blob__sender.html#add3aa0b782c02b3e1222b4ee25598ecc">More...</a><br /></td></tr>
<tr class="separator:add3aa0b782c02b3e1222b4ee25598ecc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a923cff103f564573c90999e545e1f644"><td class="memTemplParams" colspan="2">template&lt;typename Task_err &gt; </td></tr>
<tr class="memitem:a923cff103f564573c90999e545e1f644"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__sender.html#a923cff103f564573c90999e545e1f644">async_end_sending</a> (<a class="el" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a> *sync_err_code, Task_err &amp;&amp;on_done_func)</td></tr>
<tr class="memdesc:a923cff103f564573c90999e545e1f644"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equivalent to <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__sender.html#add3aa0b782c02b3e1222b4ee25598ecc" title="In PEER state: Synchronously, non-blockingly sends one discrete message, reliably and in-order,...">send_blob()</a> but sends a graceful-close message instead of the usual payload.  <a href="classipc_1_1transport_1_1sync__io_1_1Blob__sender.html#a923cff103f564573c90999e545e1f644">More...</a><br /></td></tr>
<tr class="separator:a923cff103f564573c90999e545e1f644"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4fd1a24f1221886230ffc18313eaedce"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__sender.html#a4fd1a24f1221886230ffc18313eaedce">end_sending</a> ()</td></tr>
<tr class="memdesc:a4fd1a24f1221886230ffc18313eaedce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equivalent to <code>async_end_sending(F)</code> wherein <code>F()</code> does nothing.  <a href="classipc_1_1transport_1_1sync__io_1_1Blob__sender.html#a4fd1a24f1221886230ffc18313eaedce">More...</a><br /></td></tr>
<tr class="separator:a4fd1a24f1221886230ffc18313eaedce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab66231120f7e774e9d8dadd6b1d9b2ea"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__sender.html#ab66231120f7e774e9d8dadd6b1d9b2ea">auto_ping</a> ()</td></tr>
<tr class="memdesc:ab66231120f7e774e9d8dadd6b1d9b2ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">In PEER state: Irreversibly enables periodic auto-pinging of opposing receiver with low-level messages that are ignored except that they reset any opposing idle timer.  <a href="classipc_1_1transport_1_1sync__io_1_1Blob__sender.html#ab66231120f7e774e9d8dadd6b1d9b2ea">More...</a><br /></td></tr>
<tr class="separator:ab66231120f7e774e9d8dadd6b1d9b2ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a4d20629fcc4dd808225623502920d2a5"><td class="memItemLeft" align="right" valign="top"><a id="a4d20629fcc4dd808225623502920d2a5" name="a4d20629fcc4dd808225623502920d2a5"></a>
static const <a class="el" href="namespaceipc_1_1transport.html#a33de1c256addb3964b839dc2dd407d24">Shared_name</a>&#160;</td><td class="memItemRight" valign="bottom"><b>S_RESOURCE_TYPE_ID</b></td></tr>
<tr class="memdesc:a4d20629fcc4dd808225623502920d2a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same notes as for <a class="el" href="classipc_1_1transport_1_1Blob__sender.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order sending ...">transport::Blob_sender</a>. <br /></td></tr>
<tr class="separator:a4d20629fcc4dd808225623502920d2a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >A documentation-only <em>concept</em>: what <a class="el" href="classipc_1_1transport_1_1Blob__sender.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order sending ...">transport::Blob_sender</a> is to <a class="el" href="classipc_1_1transport_1_1Native__handle__sender.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order sending ...">transport::Native_handle_sender</a> (namely a degenerate version thereof), this is to <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html" title="A documentation-only concept defining the behavior of an object that is the sync_io-pattern counterpa...">sync_io::Native_handle_sender</a>. </p>
<p >The concept is exactly identical to <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html" title="A documentation-only concept defining the behavior of an object that is the sync_io-pattern counterpa...">sync_io::Native_handle_sender</a> except that in the latter each message consists of 0-1 native handles and 0-1 binary blobs; whereas here it is always exactly 1 of the latter. More precisely, each message contains 1 binary blob, whose length must be at least 1 byte.</p>
<p >Therefore we keep the documentation very light, only pointing out the differences against <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html" title="A documentation-only concept defining the behavior of an object that is the sync_io-pattern counterpa...">sync_io::Native_handle_sender</a> &ndash; which are summarized in the preceding paragraph. All other notes from <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html" title="A documentation-only concept defining the behavior of an object that is the sync_io-pattern counterpa...">sync_io::Native_handle_sender</a> apply here.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html" title="A documentation-only concept defining the behavior of an object that is the sync_io-pattern counterpa...">sync_io::Native_handle_sender</a>, an identical concept with 1 feature (native handle transmission) added. </dd></dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ab096af43b37c0fc0169762f59e1a74dd" name="ab096af43b37c0fc0169762f59e1a74dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab096af43b37c0fc0169762f59e1a74dd">&#9670;&nbsp;</a></span>Blob_sender() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ipc::transport::sync_io::Blob_sender::Blob_sender </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Default ctor: Creates a peer object in NULL (neither connected nor connecting) state. </p>
<p >All notes from <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html" title="A documentation-only concept defining the behavior of an object that is the sync_io-pattern counterpa...">sync_io::Native_handle_sender</a> apply. </p>

</div>
</div>
<a id="a73dc49c48192a958ece03e3823b9927a" name="a73dc49c48192a958ece03e3823b9927a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73dc49c48192a958ece03e3823b9927a">&#9670;&nbsp;</a></span>Blob_sender() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ipc::transport::sync_io::Blob_sender::Blob_sender </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__sender.html">Blob_sender</a> &amp;&amp;&#160;</td>
          <td class="paramname"><em>src</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Move-constructs from <code>src</code>; <code>src</code> becomes as-if default-cted (therefore in NULL state). </p>
<p >All notes from <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html" title="A documentation-only concept defining the behavior of an object that is the sync_io-pattern counterpa...">sync_io::Native_handle_sender</a> apply.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">src</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a5b6fd92f1c435e13dcf6df40c76b3ce2" name="a5b6fd92f1c435e13dcf6df40c76b3ce2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5b6fd92f1c435e13dcf6df40c76b3ce2">&#9670;&nbsp;</a></span>~Blob_sender()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ipc::transport::sync_io::Blob_sender::~Blob_sender </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Destroys this peer endpoint which will end the conceptual outgoing-direction pipe (in PEER state, and if it's still active) and return resources to OS as applicable. </p>
<p >All notes from <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html" title="A documentation-only concept defining the behavior of an object that is the sync_io-pattern counterpa...">sync_io::Native_handle_sender</a> apply. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a923cff103f564573c90999e545e1f644" name="a923cff103f564573c90999e545e1f644"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a923cff103f564573c90999e545e1f644">&#9670;&nbsp;</a></span>async_end_sending()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Task_err &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool ipc::transport::sync_io::Blob_sender::async_end_sending </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a> *&#160;</td>
          <td class="paramname"><em>sync_err_code</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Task_err &amp;&amp;&#160;</td>
          <td class="paramname"><em>on_done_func</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Equivalent to <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__sender.html#add3aa0b782c02b3e1222b4ee25598ecc" title="In PEER state: Synchronously, non-blockingly sends one discrete message, reliably and in-order,...">send_blob()</a> but sends a graceful-close message instead of the usual payload. </p>
<p >All notes from <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html" title="A documentation-only concept defining the behavior of an object that is the sync_io-pattern counterpa...">sync_io::Native_handle_sender</a> apply.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">Task_err</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sync_err_code</td><td>See above. Do realize <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297aa667487757f9d6300f6888bac40bcc24" title="A sync_io operation could not immediately complete; it will complete contingent on active async-wait ...">error::Code::S_SYNC_IO_WOULD_BLOCK</a> <em>is</em> still an error, so if this pointer is null, then would-block <em>will</em> make this throw. </td></tr>
    <tr><td class="paramname">on_done_func</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>See above. </dd></dl>

</div>
</div>
<a id="ab66231120f7e774e9d8dadd6b1d9b2ea" name="ab66231120f7e774e9d8dadd6b1d9b2ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab66231120f7e774e9d8dadd6b1d9b2ea">&#9670;&nbsp;</a></span>auto_ping()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ipc::transport::sync_io::Blob_sender::auto_ping </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>In PEER state: Irreversibly enables periodic auto-pinging of opposing receiver with low-level messages that are ignored except that they reset any opposing idle timer. </p>
<p >All notes from <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html" title="A documentation-only concept defining the behavior of an object that is the sync_io-pattern counterpa...">sync_io::Native_handle_sender</a> apply.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">period</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>See above. </dd></dl>

</div>
</div>
<a id="a4fd1a24f1221886230ffc18313eaedce" name="a4fd1a24f1221886230ffc18313eaedce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4fd1a24f1221886230ffc18313eaedce">&#9670;&nbsp;</a></span>end_sending()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ipc::transport::sync_io::Blob_sender::end_sending </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Equivalent to <code>async_end_sending(F)</code> wherein <code>F()</code> does nothing. </p>
<p >All notes from <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html" title="A documentation-only concept defining the behavior of an object that is the sync_io-pattern counterpa...">sync_io::Native_handle_sender</a> apply.</p>
<dl class="section return"><dt>Returns</dt><dd>See above. </dd></dl>

</div>
</div>
<a id="a2a8be6c513d5ba45ef3396c4b5dd65d0" name="a2a8be6c513d5ba45ef3396c4b5dd65d0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2a8be6c513d5ba45ef3396c4b5dd65d0">&#9670;&nbsp;</a></span>operator=()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__sender.html">Blob_sender</a> &amp; ipc::transport::sync_io::Blob_sender::operator= </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__sender.html">Blob_sender</a> &amp;&amp;&#160;</td>
          <td class="paramname"><em>src</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Move-assigns from <code>src</code>; <code>*this</code> acts as if destructed; <code>src</code> becomes as-if default-cted (therefore in NULL state). </p>
<p >No-op if <code>&amp;src == this</code>.</p>
<p >All notes from <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html" title="A documentation-only concept defining the behavior of an object that is the sync_io-pattern counterpa...">sync_io::Native_handle_sender</a> apply.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">src</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>*this</code>. </dd></dl>

</div>
</div>
<a id="a15da7ad5bcf7147e6308d532f1432352" name="a15da7ad5bcf7147e6308d532f1432352"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a15da7ad5bcf7147e6308d532f1432352">&#9670;&nbsp;</a></span>replace_event_wait_handles()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Create_ev_wait_hndl_func &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool ipc::transport::sync_io::Blob_sender::replace_event_wait_handles </td>
          <td>(</td>
          <td class="paramtype">const Create_ev_wait_hndl_func &amp;&#160;</td>
          <td class="paramname"><em>create_ev_wait_hndl_func</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Coincides with <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html" title="A documentation-only concept defining the behavior of an object that is the sync_io-pattern counterpa...">sync_io::Native_handle_sender</a> concept counterpart. </p>
<p >All notes apply.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">Create_ev_wait_hndl_func</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">create_ev_wait_hndl_func</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>See above. </dd></dl>

</div>
</div>
<a id="add3aa0b782c02b3e1222b4ee25598ecc" name="add3aa0b782c02b3e1222b4ee25598ecc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add3aa0b782c02b3e1222b4ee25598ecc">&#9670;&nbsp;</a></span>send_blob()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ipc::transport::sync_io::Blob_sender::send_blob </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="namespaceipc_1_1util.html#ae0be7edba7e30ffa3f8b742af621f2ab">util::Blob_const</a> &amp;&#160;</td>
          <td class="paramname"><em>blob</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a> *&#160;</td>
          <td class="paramname"><em>err_code</em> = <code>0</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>In PEER state: Synchronously, non-blockingly sends one discrete message, reliably and in-order, to the opposing peer; the message consists of the provided binary blob (of length at least 1 byte). </p>
<p >Providing a null blob results in undefined behavior (assertion may trip).</p>
<p >Otherwise all notes from <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#a0f8f3fb816c09dd9a992a878892bbffb" title="In PEER state: Synchronously, non-blockingly sends one discrete message, reliably/in-order,...">sync_io::Native_handle_sender::send_native_handle()</a> apply.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">blob</td><td>A binary blob to send; behavior undefined unless <code>blob.size() &gt;= 1</code>. </td></tr>
    <tr><td class="paramname">err_code</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>See above. </dd></dl>

</div>
</div>
<a id="a57611f88b625f095d4a6a0f0e5d9e665" name="a57611f88b625f095d4a6a0f0e5d9e665"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a57611f88b625f095d4a6a0f0e5d9e665">&#9670;&nbsp;</a></span>send_blob_max_size()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t ipc::transport::sync_io::Blob_sender::send_blob_max_size </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>All notes from <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html" title="A documentation-only concept defining the behavior of an object that is the sync_io-pattern counterpa...">sync_io::Native_handle_sender</a> apply. </p>
<dl class="section return"><dt>Returns</dt><dd>See above. </dd></dl>

</div>
</div>
<a id="aa7676391885035faa7195c0840ae2009" name="aa7676391885035faa7195c0840ae2009"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7676391885035faa7195c0840ae2009">&#9670;&nbsp;</a></span>start_send_blob_ops()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Event_wait_func_t &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool ipc::transport::sync_io::Blob_sender::start_send_blob_ops </td>
          <td>(</td>
          <td class="paramtype">Event_wait_func_t &amp;&amp;&#160;</td>
          <td class="paramname"><em>ev_wait_func</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>All notes from <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#a8c34b110850c736c45d88689ab06c27c" title="Sets up the sync_io-pattern interaction between *this and the user&#39;s event loop; required before send...">sync_io::Native_handle_sender::start_send_native_handle_ops()</a> apply. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">Event_wait_func_t</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ev_wait_func</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>See above. </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>transport/sync_io/<a class="el" href="sync__io_2blob__transport_8hpp.html">blob_transport.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 11 2025 20:02:23 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
